Skip to content

Add GH issue tutorial request template and tutorial submission guide#622

Merged
tturocy merged 5 commits intomasterfrom
tutorial-request-issue-template
Nov 19, 2025
Merged

Add GH issue tutorial request template and tutorial submission guide#622
tturocy merged 5 commits intomasterfrom
tutorial-request-issue-template

Conversation

@edwardchalstrey1
Copy link
Copy Markdown
Member

@edwardchalstrey1 edwardchalstrey1 commented Nov 17, 2025

This PR adds a workflow for adding tutorials to the documentation, see the updated docs editing section of the contributor guide here which now contains a section specifically on adding Jupyter notebook tutorials.

  • Add new issue template for tutorials
  • Add a "How to add tutorials" section to the contributor docs which explains:
    1. Open an issue with your tutorial request
    2. If you seek to author the tutorial yourself, open a new PR that:
      • Adds the new tutorial as a .ipynb in doc/tutorials in the appropriate sub-folder (or creates a new one)
      • Updates doc/pygambit.rst to ensure the tutorial is listed in the docs at an appropriate location

@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review November 18, 2025 10:28
@edwardchalstrey1 edwardchalstrey1 changed the title Add GH issue tutorial request template Add GH issue tutorial request template and tutorial submission guide Nov 18, 2025
@edwardchalstrey1 edwardchalstrey1 moved this from In progress to In review in Ed Chalstrey Gambit priorities Nov 18, 2025
@tturocy tturocy merged commit 82ca217 into master Nov 19, 2025
28 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in Ed Chalstrey Gambit priorities Nov 19, 2025
@tturocy tturocy deleted the tutorial-request-issue-template branch November 19, 2025 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants